Get-RASSchedule

NAME

Get-RASSchedule

SYNOPSIS

Retrieves information about one or multiple Schedule properties.

SYNTAX

Get-RASSchedule [-Id] <uint> -ObjType {RDS | VDI | AVD} [-TargetType {Host | HostPool}] [<CommonParameters>]

Get-RASSchedule [[-Name] <string>] [[-SiteId] <uint>] -ObjType {RDS | VDI | AVD} [-TargetType {Host | HostPool}] [<CommonParameters>]

DESCRIPTION

The cmdlet returns an object of type Schedule properties. To see the complete list of object properties, use the Format-List cmdlet(see examples). The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.

PARAMETERS


-Name <string>
Scheduler job name. 

        Required?                    false
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
Site ID from which to retrieve the schedule job. 

        Required?                    false
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Id <uint>
Scheduler job ID. 

        Required?                    true
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ObjType <ScheduleObjType>
Schedule object type.

Possible values: RDS, VDI, AVD 

        Required?                    true
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-TargetType <ScheduleTargetType>
Schedule target type.

Possible values: Host, HostPool 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

<CommonParameters> 
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

Schedule

EXAMPLES


---------- EXAMPLE 1 ----------

Get-RASSchedule "My Schedule" | Format-List

Retrieves information about the Schedule properties specified by name from the Licensing Server site. To retrieve the info from a specific site, specify the -SiteId parameter. The Format-List cmdlet formats the display output to include all available group properties.
---------- EXAMPLE 2 ----------

Get-RASSchedule -Id 10

Retrieves information about the Schedule specified by ID from the Licensing Server site.

RELATED LINKS